Crate notify_debouncer_full

A debouncer for notify that is optimized for ease of use.

• Only emits a single Rename event if the rename From and To events can be matched
• Merges multiple Rename events
• Optionally keeps track of the file system IDs all files and stiches rename events together (FSevents, Windows)
• Emits only one Remove event when deleting a directory (inotify)
• Doesn’t emit duplicate create events
• Doesn’t emit Modify events after a Create event

Installation

[dependencies]
notify-debouncer-full = "0.1.0"

In case you want to select specific features of notify, specify notify as dependency explicitely in your dependencies. Otherwise you can just use the re-export of notify from debouncer-easy.

notify-debouncer-full = "0.1.0"
notify = { version = "..", features = [".."] }

Examples

use notify_debouncer_full::{notify::*, new_debouncer, DebounceEventResult};

// Select recommended watcher for debouncer.
// Using a callback here, could also be a channel.
let mut debouncer = new_debouncer(Duration::from_secs(2), None, |result: DebounceEventResult| {
    match result {
        Ok(events) => events.iter().for_each(|event| println!("{event:?}")),
        Err(errors) => errors.iter().for_each(|error| println!("{error:?}")),
    }
}).unwrap();

// Add a path to be watched. All files and directories at that path and
// below will be monitored for changes.
debouncer.watcher().watch(Path::new("."), RecursiveMode::Recursive).unwrap();

// Add the same path to the file ID cache. The cache uses unique file IDs
// provided by the file system and is used to stich together rename events
// in case the notification back-end doesn't emit rename cookies.
debouncer.cache().add_root(Path::new("."), RecursiveMode::Recursive);

Features

The following crate features can be turned on or off in your cargo dependency config:

• crossbeam enabled by default, adds DebounceEventHandler support for crossbeam channels. Also enables crossbeam-channel in the re-exported notify. You may want to disable this when using the tokio async runtime.
• serde enables serde support for events.

Re-exports

• pub use file_id;
• pub use notify;

Structs

• Debouncer
  Debouncer guard, stops the debouncer on drop.
• FileIdMap
  A cache to hold the file system IDs of all watched files.
• NoCache
  An implementation of the FileIdCache trait that doesn’t hold any data.

Traits

• DebounceEventHandler
  The set of requirements for watcher debounce event handling functions.
• FileIdCache
  The interface of a file ID cache.

Functions

• new_debouncer
  Short function to create a new debounced watcher with the recommended debouncer and the built-in file ID cache.
• new_debouncer_opt
  Creates a new debounced watcher with custom configuration.

Type Definitions

• DebounceEventResult
  A result of debounced events. Comes with either a vec of events or vec of errors.
• DebouncedEvent
  A debounced event. At the moment this is the same as a normal event.